docs: align JavaScript SDK documentation - #993
Merged
Merged
Conversation
Deploying devcycle-docs with
|
| Latest commit: |
623f2e3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://10bc6152.devcycle-docs.pages.dev |
| Branch Preview URL: | https://docs-sdk-javascript.devcycle-docs.pages.dev |
jonathannorris
marked this pull request as ready for review
August 6, 2026 18:11
jonathannorris
force-pushed
the
docs-sdk-javascript
branch
from
August 6, 2026 18:12
729f03e to
5bdc51e
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates multiple JavaScript-family SDK docs (Node.js, NestJS, React, React Native, Next.js, Angular, and plain JS) to reflect current initialization APIs, runtime requirements, and usage patterns.
Changes:
- Updates Node.js/NestJS initialization and bootstrapping guidance (including runtime requirements and bootstrapping key usage).
- Refreshes client-side framework docs (React helpers, React Native examples/requirements, Next.js and Angular usage notes).
- Aligns JavaScript client SDK documentation with current logging and bootstrapping options.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/sdk/server-side-sdks/node/node.md | Adds a stated minimum Node.js runtime requirement. |
| docs/sdk/server-side-sdks/node/node-gettingstarted.md | Updates Node.js SDK initialization examples and options usage. |
| docs/sdk/server-side-sdks/node/node-bootstrapping.md | Clarifies bootstrapping prerequisites and the bootstrap config client key field name. |
| docs/sdk/server-side-sdks/nestjs/nestjs-gettingstarted.md | Clarifies NestJS module bucketing mode and fixes the async userFactory example. |
| docs/sdk/client-side-sdks/react/react-usage.md | Adds conditional rendering helper documentation and an example. |
| docs/sdk/client-side-sdks/react-native/react-native.md | Updates stated React Native / React version requirements. |
| docs/sdk/client-side-sdks/react-native/react-native-usage.md | Fixes React Native example to use RN components and correct boolean defaults. |
| docs/sdk/client-side-sdks/react-native/react-native-expo-install.md | Updates Expo dependency install guidance and clarifies SSE dependency expectations. |
| docs/sdk/client-side-sdks/nextjs/nextjs-usage-app.md | Exposes track from setup and updates realtime updates/version guidance. |
| docs/sdk/client-side-sdks/javascript/javascript-gettingstarted.md | Updates logging option terminology and adds a bootstrapping option to the options table. |
| docs/sdk/client-side-sdks/angular/angular-usage.md | Updates DevCycle client access pattern and removes trailing whitespace. |
Suppressed comments (1)
docs/sdk/server-side-sdks/node/node-gettingstarted.md:52
- This JS snippet uses CommonJS
require(...)but also usesawaitat top level. Either wrap the snippet in an async function or switch the JS example to a promise chain so it runs as-written in CommonJS.
const devcycleClient = await initializeDevCycle(
'<DEVCYCLE_SERVER_SDK_KEY>',
{
// Insert Options
},
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jonathannorris
force-pushed
the
docs-sdk-javascript
branch
from
August 7, 2026 16:03
9e66210 to
39e442d
Compare
suthar26
approved these changes
Aug 7, 2026
JamieSinn
approved these changes
Aug 7, 2026
jonathannorris
force-pushed
the
docs-sdk-javascript
branch
from
August 7, 2026 17:56
39e442d to
623f2e3
Compare
jonathannorris
enabled auto-merge (squash)
August 7, 2026 17:56
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Validation